<!DOCTYPE html>
<html lang="en">
<head>
	<meta charset="UTF-8">
	<meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">
	<title>Pause auto-follow pattern API | ElasticSearch 7.7 权威指南中文版</title>
	<meta name="keywords" content="ElasticSearch 权威指南中文版, elasticsearch 7, es7, 实时数据分析，实时数据检索" />
    <meta name="description" content="ElasticSearch 权威指南中文版, elasticsearch 7, es7, 实时数据分析，实时数据检索" />
    <!-- Give IE8 a fighting chance -->
    <!--[if lt IE 9]>
    <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
    <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
    <![endif]-->
	<link rel="stylesheet" type="text/css" href="../static/styles.css" />
	<script>
	var _link = 'ccr-pause-auto-follow-pattern.html';
    </script>
</head>
<body>
<div class="main-container">
    <section id="content">
        <div class="content-wrapper">
            <section id="guide" lang="zh_cn">
                <div class="container">
                    <div class="row">
                        <div class="col-xs-12 col-sm-8 col-md-8 guide-section">
                            <div style="color:gray; word-break: break-all; font-size:12px;">原英文版地址: <a href="https://www.elastic.co/guide/en/elasticsearch/reference/7.7/ccr-pause-auto-follow-pattern.html" rel="nofollow" target="_blank">https://www.elastic.co/guide/en/elasticsearch/reference/7.7/ccr-pause-auto-follow-pattern.html</a>, 原文档版权归 www.elastic.co 所有<br/>本地英文版地址: <a href="../en/ccr-pause-auto-follow-pattern.html" rel="nofollow" target="_blank">../en/ccr-pause-auto-follow-pattern.html</a></div>
                        <!-- start body -->
                  <div class="page_header">
<strong>重要</strong>: 此版本不会发布额外的bug修复或文档更新。最新信息请参考 <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html" rel="nofollow">当前版本文档</a>。
</div>
<div id="content">
<div class="breadcrumbs">
<span class="breadcrumb-link"><a href="index.html">Elasticsearch Guide [7.7]</a></span>
»
<span class="breadcrumb-link"><a href="rest-apis.html">REST APIs</a></span>
»
<span class="breadcrumb-link"><a href="ccr-apis.html">Cross-cluster replication APIs</a></span>
»
<span class="breadcrumb-node">Pause auto-follow pattern API</span>
</div>
<div class="navheader">
<span class="prev">
<a href="ccr-get-auto-follow-pattern.html">« Get auto-follow pattern API</a>
</span>
<span class="next">
<a href="ccr-resume-auto-follow-pattern.html">Resume auto-follow pattern API »</a>
</span>
</div>
<div class="section xpack">
<div class="titlepage"><div><div>
<h2 class="title">
<a id="ccr-pause-auto-follow-pattern"></a>Pause auto-follow pattern API<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/ccr/apis/auto-follow/pause-auto-follow-pattern.asciidoc">edit</a><a class="xpack_tag" href="https://www.elastic.co/subscriptions"></a>
</h2>
</div></div></div>

<p>Pauses an auto-follow pattern.</p>
<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="ccr-pause-auto-follow-pattern-request"></a>Request<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/ccr/apis/auto-follow/pause-auto-follow-pattern.asciidoc">edit</a>
</h3>
</div></div></div>
<p><code class="literal">POST /_ccr/auto_follow/&lt;auto_follow_pattern_name&gt;/pause</code></p>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="ccr-pause-auto-follow-pattern-prereqs"></a>Prerequisites<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/ccr/apis/auto-follow/pause-auto-follow-pattern.asciidoc">edit</a>
</h3>
</div></div></div>
<div class="ulist itemizedlist">
<ul class="itemizedlist">
<li class="listitem">
If the Elasticsearch security features are enabled, you must have <code class="literal">manage_ccr</code> cluster
privileges on the cluster that contains the follower index. For more information,
see <a class="xref" href="security-privileges.html" title="Security privileges">Security privileges</a>.
</li>
</ul>
</div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="ccr-pause-auto-follow-pattern-desc"></a>Description<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/ccr/apis/auto-follow/pause-auto-follow-pattern.asciidoc">edit</a>
</h3>
</div></div></div>
<p>This API pauses an <a class="xref" href="ccr-auto-follow.html" title="Automatically following indices">auto-follow pattern</a>. When this API returns, the auto-follow pattern
is inactive and ignores any new index created on the remote cluster that matches any of
the auto-follow’s patterns. Paused auto-follow patterns appear with the <code class="literal">active</code> field
set to <code class="literal">false</code> in the <a class="xref" href="ccr-get-auto-follow-pattern.html" title="Get auto-follow pattern API">GET auto-follow patterns API</a>.</p>
<p>You can resume auto-following with the <a class="xref" href="ccr-resume-auto-follow-pattern.html" title="Resume auto-follow pattern API">resume auto-follow pattern API</a>.
Once resumed, the auto-follow pattern is active again and automatically configure
follower indices for newly created indices on the remote cluster that match its patterns.
Remote indices created while the
pattern was paused will also be followed, unless they have been deleted or closed in the
meantime.</p>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="ccr-pause-auto-follow-pattern-path-parms"></a>Path parameters<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/ccr/apis/auto-follow/pause-auto-follow-pattern.asciidoc">edit</a>
</h3>
</div></div></div>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">&lt;auto_follow_pattern_name&gt;</code>
</span>
</dt>
<dd>
(Required, string) Name of the auto-follow pattern to pause.
</dd>
</dl>
</div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="ccr-pause-auto-follow-pattern-examples"></a>Examples<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/ccr/apis/auto-follow/pause-auto-follow-pattern.asciidoc">edit</a>
</h3>
</div></div></div>
<p>This example pauses an auto-follow pattern named <code class="literal">my_auto_follow_pattern</code>:</p>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">POST /_ccr/auto_follow/my_auto_follow_pattern/pause</pre>
</div>
<div class="console_widget" data-snippet="snippets/1449.console"></div>
<p>The API returns the following result:</p>
<div class="pre_wrapper lang-console-result">
<pre class="programlisting prettyprint lang-console-result">{
  "acknowledged" : true
}</pre>
</div>
</div>

</div>
<div class="navfooter">
<span class="prev">
<a href="ccr-get-auto-follow-pattern.html">« Get auto-follow pattern API</a>
</span>
<span class="next">
<a href="ccr-resume-auto-follow-pattern.html">Resume auto-follow pattern API »</a>
</span>
</div>
</div>

                  <!-- end body -->
                        </div>
                        <div class="col-xs-12 col-sm-4 col-md-4" id="right_col">
                        
                        </div>
                    </div>
                </div>
            </section>
        </div>
    </section>
</div>
<script src="../static/cn.js"></script>
</body>
</html>